sdk/samples/all in on code/Visual Studio 2008/CSVSPackageStatusBar/ReadMe.txt

   1 =============================================================================
   2   Visual Studio VSPackage : CSVSPackageStatusBar Project Overview
   3 =============================================================================
   4
   5 /////////////////////////////////////////////////////////////////////////////
   6 Use:
   7
   8 The Visual Studio status bar, the horizontal region at the bottom of the
   9 Visual Studio design surface, provides a convenient way to convey information
  10 about the current state of the integrated development environment (IDE).
  11 The status bar comprises four programmable regions, as shown in the following
  12 table:
  13
  14 Feedback
  15 Displays text. You can set and retrieve text, display static text, and highlight
  16 the displayed text.
  17
  18 Progress Bar
  19 Displays incremental progress for quick operations, such as saving a single file
  20  to disk.
  21
  22 Animation
  23 Displays a continuously looped animation, which indicates either a lengthy
  24 operation or an operation of indeterminate length (for example, building multiple
  25 projects in a solution).
  26
  27 Designer
  28 Displays information pertinent to editing, such as the line number or column
  29 number of the cursor location.
  30
  31 In this sample, we will demo:
  32 1. Write highlighted text in feedback region
  33 2. Read text from feedback region
  34 3. Show progress bar in status bar
  35 4. Show animation in the status bar
  36 5. Write row, column and char to designer region
  37
  38 /////////////////////////////////////////////////////////////////////////////
  39 Prerequisites:
  40
  41 VS 2008 SDK must be installed on the machine. You can download it from:
  42 http://www.microsoft.com/downloads/details.aspx?FamilyID=30402623-93ca-479a-
  43 867c-04dc45164f5b&displaylang=en
  44
  45 Otherwise the project may not be opened by Visual Studio.
  46
  47 NOTE: The Package Load Failure Dialog occurs because there is no
  48       PLK(Package Load Key) Specified in this package. To obtain a PLK, please
  49       to go to WebSite:
  50       http://msdn.microsoft.com/en-us/vsx/cc655795.aspx
  51       More info:
  52       http://msdn.microsoft.com/en-us/library/bb165395.aspx
  53
  54
  55 /////////////////////////////////////////////////////////////////////////////
  56 Creation:
  57
  58 To write the Feedback region of the Visual Studio Status bar
  59 1. Obtain an instance of the IVsStatusbar interface, which is made
  60 available through the SVsStatusbar service.
  61 2. SetColorText only displays white text on a dark blue background.
  62 3. SetText to set text in the feedback region
  63
  64 To read the Feedback region of the Visual Studio Status bar
  65 1. Obtain an instance of the IVsStatusbar interface, which is made
  66 available through the SVsStatusbar service.
  67 2. GetText to get the text from the feedback region
  68
  69 To show progress bar in the status bar
  70 1. Obtains an instance of the IVsStatusbar interface from the SVsStatusbar service.
  71 2. Initializes the progress bar to given starting values by calling the Progress
  72 method.
  73 3. Simulates an operation by iterating through a for loop and updating the progress
  74 bar values using the Progress method.
  75 4. Clears the progress bar using the Clear method.
  76
  77 To use the animation region of status bar
  78 1. Obtain an instance of the IVsStatusbar interface, which is made available through
  79 the SVsStatusbar service.
  80 2. Start the animation by calling the Animation method of the status bar. Pass in 1
  81 as the value of the first parameter, and a reference to an animated icon as the value
  82 of the second parameter.
  83 3. Stop the animation by calling the Animation method of the status bar. Pass in 0 as
  84 the value of the first parameter, and a reference to the animated icon as the value of
  85 the second parameter.
  86
  87 To program the designer region of the status bar
  88 1. Obtain an instance of the IVsStatusbar interface, which is made available through
  89 the SVsStatusbar service.
  90 2. Update the Designer region of the status bar by calling the SetInsMode and
  91 SetLineColChar methods of the IVsStatusbar instance.
  92
  93 /////////////////////////////////////////////////////////////////////////////
  94 References:
  95
  96 MSDN: Status Bar
  97 http://msdn.microsoft.com/en-us/library/bb166795.aspx
  98
  99 /////////////////////////////////////////////////////////////////////////////